Using HyperPoints

When a HyperPoint is created, it is set up with specific events and objects around which scripts can be built. This section gives an overview of how these built-in objects and events interrelate. See CygNet Scripting Guide for more information about HyperPoint events.

Objects

A HyperPoint is typically configured to monitor other point values and do processing related to them. Therefore, each HyperPoint uses a Points object to track these other points. Points can be added to the Points object using the Points.AddPoint method (see HyperPoint Scripting Examples: Summation for an example). To do any processing related to a point in the Points object, a reference to the point must be created. This is accomplished using the Points.Point method, which returns a Point object representing the indicated point. This Point object is read only and can be thought of as a snapshot of a point at a given time.

Each HyperPoint also includes an object called Timer. You can use this built-in object to specify an interval on which the OnTimer event will be run (see Events below). The Timer.Set method is used to set the interval for the timer. The Master Scheduling Service (MSS) can be used instead of a timer for handling a large number of related scripts or for applying more complex timed execution sequences.

Tip: To use the MSS to execute scripts, create a "trigger" point in the HSS that can be added to a HyperPoint’s Points collection. Then set up the MSS to perform a setpoint request to the trigger point. This will trigger the script’s OnPointChange event to run.

Another built-in object for use by HyperPoints is the Facilities object, which is used for caching facility attributes. Facilities can be added to the Facilities object in order to quickly get information about them later. Like the Points object, the Facilities object can be set to update automatically when facility information is changed.

HyperPoints have access to a number of Global Functions in addition to these objects, such as SetPoint for setting point values and SendUISCommand for sending UIS commands. A complete list of these functions is provided in the Scripting section. It is a good idea to familiarize yourself with these functions in order to know what common operations are possible.

Events

When a HyperPoint is created, its script editor includes the point itself as an object (in the Object drop-down menu) as well as four events (in the Event drop-down menu) — OnInitializeEx, OnPointChange, OnTerminateEx, and OnTimer. These are usually the only events that need to be configured for a HyperPoint.